Declaration:

PROCEDURE   BeginColumn

( columnDistance:REAL ) ;

Description:

Procedure BeginColumn creates a column object in a Vectorworks document using 2D object creation procedure calls to define the "template" for the column object.

After specifying object procedure calls to define the column, you should call EndGroup to complete the column definition and create the actual object.

Parameters:

columnDistance

Height of column.

Example:

BeginColumn(12');
  Oval(2',2',6',6');
EndGroup;

Declaration:

PROCEDURE   BeginFloor

( thicknessDistance:REAL ) ;

Description:

Procedure BeginFloor creates a new floor object in a Vectorworks document. BeginFloor uses 2D object creation procedure calls to define the "template" for the object.

After specifying object procedure calls to define the floor object, you should call EndGroup to complete the column definition and create the actual object.

Parameters:

thicknessDistance

Floor thickness.

Example:

BeginFloor(6");
Rect(1,1,5,5);
EndGroup;

Declaration:

PROCEDURE   ConvertToUnstyledSlab

( slab:HANDLE ) ;

Description:

Sets a slab to be unstyled.

Parameters:

slab

The slab.

Declaration:

FUNCTION   CreateSlab

( profile:HANDLE ) :HANDLE ;

Description:

Creates a slab.

Parameters:

profile

The profile from which to create the slab.

Result:

The slab.

See Also:

ModifySlab  

Declaration:

FUNCTION   CreateSlabStyle

( slabStyleName:STRING ) :HANDLE ;

Description:

Creates a new Slab Style of the given name. If the name is already in use, the next available name will be used.

Parameters:

slabStyleName

The name of the new Slab Style. If the name is already in use, the next available name will be used.

Result:

The new Slab Style.

Declaration:

FUNCTION   DeleteAllComponents

( object:HANDLE ) :BOOLEAN ;

Description:

Deletes all components in an object.

Parameters:

object

The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.

Declaration:

FUNCTION   DeleteComponent

(   object :HANDLE;     componentIndex :INTEGER ) :BOOLEAN ;

Description:

Deletes a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component to delete.

See Also:

InsertNewComponent  

Declaration:

PROCEDURE   DelObjStoryBound

(   object :HANDLE;     boundID :INTEGER ) ;

Description:

Delete the specified story bounds from this object.

Parameters:

object	The object.
boundID	The identifier of the story bound.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

PROCEDURE   DelObjStoryBounds

( object:HANDLE ) ;

Description:

Delete all story bounds for this object.

Parameters:

object

The object.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   GetComponentAutoBoundEdgeOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  autoBoundEdgeOffset :INTEGER ) :BOOLEAN ;

Description:

Gets the auto-bound edge offset of a component in an object.

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.
componentIndex	The index of the component.
autoBoundEdgeOffset	Returns the auto-bound edge offset. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component 6 - Outer face

See Also:

SetComponentAutoBoundEdgeOffset  

Declaration:

FUNCTION   GetComponentClass

(   object :HANDLE;     componentIndex :INTEGER;   VAR  componentClass :LONGINT ) :BOOLEAN ;

Description:

Gets the class of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
componentClass	Returns the class of the component.

See Also:

SetComponentClass  

Declaration:

FUNCTION   GetComponentFill

(   object :HANDLE;     componentIndex :INTEGER;   VAR  fill :LONGINT ) :BOOLEAN ;

Description:

Gets the fill of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
fill	Returns the fill of the component. Positive values for patterns, negative ref numbers for hatches.

See Also:

SetComponentFill  

Declaration:

FUNCTION   GetComponentFillColors

(   object :HANDLE;     componentIndex :INTEGER;   VAR  fillForeColor :INTEGER;   VAR  fillBackColor :INTEGER ) :BOOLEAN ;

Description:

Gets the fore and back fill colors of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
fillForeColor	Returns the fore color of the fill.
fillBackColor	Returns the back color of the fill.

See Also:

SetComponentFillColors  

Declaration:

FUNCTION   GetComponentFollowBottomWallPeaks

(   object :HANDLE;     componentIndex :INTEGER;   VAR  followBottomWallPeaks :BOOLEAN ) :BOOLEAN ;

Description:

Gets the follow bottom wall peaks flag of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
followBottomWallPeaks	Returns whether or not the component is following bottom wall peaks.

See Also:

SetComponentFollowBottomWallPeaks  

Declaration:

FUNCTION   GetComponentFollowTopWallPeaks

(   object :HANDLE;     componentIndex :INTEGER;   VAR  followTopWallPeaks :BOOLEAN ) :BOOLEAN ;

Description:

Gets the follow top wall peaks flag of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
followTopWallPeaks	Returns whether or not the component is following top wall peaks.

See Also:

SetComponentFollowTopWallPeaks  

Declaration:

FUNCTION   GetComponentManualEdgeOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  manualEdgeOffset :REAL ) :BOOLEAN ;

Description:

Gets the manual edge offset of a component in an object.

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.
componentIndex	The index of the component.
manualEdgeOffset	Returns the manual edge offset.

See Also:

SetComponentManualEdgeOffset  

Declaration:

FUNCTION   GetComponentName

(   object :HANDLE;     componentIndex :INTEGER ) :STRING ;

Description:

Gets the name of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.

Result:

The name of the component.

See Also:

SetComponentName  

Declaration:

FUNCTION   GetComponentNetArea

(   object :HANDLE;     componentIndex :INTEGER ) :REAL ;

Description:

Gets the net area of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.

Result:

The net area of the component.

See Also:

GetComponentNetVolume  

Declaration:

FUNCTION   GetComponentNetVolume

(   object :HANDLE;     componentIndex :INTEGER ) :REAL ;

Description:

Gets the net volume of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.

Result:

The net volume of the component.

See Also:

GetComponentNetArea  

Declaration:

FUNCTION   GetComponentPenColors

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenForeColor :INTEGER;   VAR  leftPenBackColor :INTEGER;   VAR  rightPenForeColor :INTEGER;   VAR  rightPenBackColor :INTEGER ) :BOOLEAN ;

Description:

Gets the colors of the pens of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
leftPenForeColor	Returns the fore color of the left pen.
leftPenBackColor	Returns the back color of the left pen.
rightPenForeColor	Returns the fore color of the right pen.
rightPenBackColor	Returns the back color of the right pen.

See Also:

SetComponentPenColors  

Declaration:

FUNCTION   GetComponentPenStyles

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenStyle :INTEGER;   VAR  rightPenStyle :INTEGER ) :BOOLEAN ;

Description:

Gets the left and right side pen styles of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
leftPenStyle	Returns the pen style of the component's left line. Positive values for patterns, negative values for dash styles.
rightPenStyle	Returns the pen style of the component's right line. Positive values for patterns, negative values for dash styles.

See Also:

SetComponentPenStyles  

Declaration:

FUNCTION   GetComponentPenWeights

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenWeight :INTEGER;   VAR  rightPenWeight :INTEGER ) :BOOLEAN ;

Description:

Gets the pen weights of the left and right sides of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
leftPenWeight	Returns the pen weight of the component's left line.
rightPenWeight	Returns the pen weight of the component's right line.

See Also:

SetComponentPenWeights  

Declaration:

FUNCTION   GetComponentTexture

(   object :HANDLE;     componentIndex :INTEGER;   VAR  texture :LONGINT ) :BOOLEAN ;

Description:

Gets the texture of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
texture	Returns the ref number of the texture. 0 for no texture. -1 for class texture.

See Also:

SetComponentTexture  

Declaration:

FUNCTION   GetComponentUseFillClassAttr

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useFillClassAttributes :BOOLEAN ) :BOOLEAN ;

Description:

Gets the use fill class attributes flag of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
useFillClassAttributes	Returns whether or not the component is using class attributes for its fill.

See Also:

SetComponentUseFillClassAttr  

Declaration:

FUNCTION   GetComponentUsePenClassAttr

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useLeftPenClassAttributes :BOOLEAN;   VAR  useRightPenClassAttributes :BOOLEAN ) :BOOLEAN ;

Description:

Gets the use class attributes flags of the pens of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
useLeftPenClassAttributes	Returns whether or not the component is using class attributes for its left pen.
useRightPenClassAttributes	Returns whether or not the component is using class attributes for its right pen.

See Also:

SetComponentUsePenClassAttr  

Declaration:

FUNCTION   GetComponentWallBottomOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  offsetFromWallBottom :REAL ) :BOOLEAN ;

Description:

Gets the offset from wall bottom of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
offsetFromWallBottom	Returns the offset from wall bottom of the component.

See Also:

SetComponentWallBottomOffset  

Declaration:

FUNCTION   GetComponentWallTopOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  offsetFromWallTop :REAL ) :BOOLEAN ;

Description:

Gets the offset from wall top of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
offsetFromWallTop	Returns the offset from wall top of the component.

See Also:

SetComponentWallTopOffset  

Declaration:

FUNCTION   GetComponentWidth

(   object :HANDLE;     componentIndex :INTEGER;   VAR  width :REAL ) :BOOLEAN ;

Description:

Gets the width of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
width	Returns the width of the component.

See Also:

SetComponentWidth  

Declaration:

FUNCTION   GetCoreWallComponent

( object:HANDLE ) :INTEGER ;

Description:

Gets the core wall component of an object.

Parameters:

object

The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.

Result:

The index of the core wall component. If it is 0, there is no core wall component.

See Also:

SetCoreWallComponent  

Declaration:

FUNCTION   GetDatumSlabComponent

( object:HANDLE ) :INTEGER ;

Description:

Gets the datum slab component of an object.

Parameters:

object

The object. Can be a slab, Slab Style, or the Slab Preferences.

Result:

The index of the datum slab component.

See Also:

SetDatumSlabComponent  

Declaration:

FUNCTION   GetNumberOfComponents

(   object :HANDLE;   VAR  numComponents :INTEGER ) :BOOLEAN ;

Description:

Gets the number of components in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
numComponents	Returns the number of components.

Declaration:

FUNCTION   GetObjBoundElevation

(   object :HANDLE;     boundID :INTEGER ) :REAL ;

Description:

Get the elevation of the specified bound ID relative to the object's layer.

Parameters:

object	The object.
boundID	The identifier of the story bound.

Result:

Return the elevation of the specified bound ID relative to the object's layer.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   GetObjStoryBound

(   object :HANDLE;     boundID :INTEGER;   VAR  boundType :INTEGER;   VAR  boundStory :INTEGER;   VAR  layerLevelType :STRING;   VAR  offset :REAL ) :BOOLEAN ;

Description:

Get the data of the specified story bound of this object.

Parameters:

object	The object.
boundID	The identifier of the story bound.
boundType	Bounding type: 0 - DefaultWallHeight; 1 - LayerZ; 2 - Story
boundStory	The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below.
layerLevelType	The layer type which defines this bound
offset	The offset distance from the specified bound story

Result:

Return TRUE if the operation is successful.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   GetObjStoryBoundsAt

(   object :HANDLE;     index :INTEGER ) :INTEGER ;

Description:

Return the story bound ID of the specified story bound index. The index is between 1 and the result of GetObjStoryBoundsCnt.

Parameters:

object	The object.
index	Index of the story bound which ID will be returned. This indes should be between 1 and the result of GetObjStoryBoundsCnt.

Result:

Return the story bound ID.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   GetObjStoryBoundsCnt

( object:HANDLE ) :INTEGER ;

Description:

Return the number of story bounds defined for this object.

Parameters:

object

The object.

Result:

The number of story bounds for this object.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   GetSlabHeight

( slab:HANDLE ) :REAL ;

Description:

Gets the height of a slab.

Parameters:

slab

The slab.

Result:

The height of the slab.

See Also:

SetSlabHeight  

Declaration:

FUNCTION   GetSlabPreferences

:HANDLE ;

Description:

Gets the Slab Preferences. This can be used with the component calls and the Style selectors.

Result:

The Slab Preferences.

Declaration:

FUNCTION   GetSlabPreferencesStyle

:LONGINT ;

Description:

Gets the Slab Style of the Slab Preferences.

Result:

The ref number of the Slab Style of the Slab Preferences. 0 for unstyled.

See Also:

SetSlabPreferencesStyle  

Declaration:

FUNCTION   GetSlabStyle

( slab:HANDLE ) :LONGINT ;

Description:

Gets the Slab Style of a slab.

Parameters:

slab

The slab.

Result:

The ref number of the Slab Style of the slab. 0 for unstyled.

See Also:

SetSlabStyle  

Declaration:

FUNCTION   GetStoryLayerInfo

(   index :INTEGER;   VAR  name :STRING;   VAR  scaleFactor :REAL;   VAR  layerLevelType :STRING;   VAR  eleveationOffset :REAL;   VAR  defaultWallHeight :REAL ) :Boolean ;

Description:

Returns information on the given story layer template

Parameters:

index	Index of story.
name	Returns with Name of story layer template
scaleFactor	Returns with Scale Factor of story layer template
layerLevelType	Returns with Level Type of story layer template
eleveationOffset	Returns with the Elevation Offset of story layer template
defaultWallHeight	Returns with the Default Wall Height of story layer template

Result:

Boolean - TRUE if the story at given index was found, FALSE if no story was found at the given index.

Declaration:

FUNCTION   GetWallPreferences

:HANDLE ;

Description:

Gets the Wall Preferences. This can be used with the component calls and the Style selectors.

Result:

The Wall Preferences.

Declaration:

FUNCTION   HasObjStoryBound

(   object :HANDLE;     boundID :INTEGER ) :BOOLEAN ;

Description:

Determine if the object has the specified story bound ID present.

Parameters:

object	The object.
boundID	The identifier of the story bound.

Result:

Retrun TRUE if the story bound ID is present. Otherwise - FALSE.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   HasObjStoryBounds

( object:HANDLE ) :BOOLEAN ;

Description:

Determine if the object has any story bounds.

Parameters:

object

The object.

Result:

Return TRUE if the object has any story bounds. Otherwise - FALSE.

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

FUNCTION   InsertNewComponent

(   object :HANDLE;     beforeComponentIndex :INTEGER;     width :REAL;     fill :LONGINT;     leftPenWeight :INTEGER;     rightPenWeight :INTEGER;     leftPenStyle :INTEGER;     rightPenStyle :INTEGER ) :BOOLEAN ;

Description:

Inserts a new component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
beforeComponentIndex	The index before which to insert the new component.
width	The width of the component.
fill	The fill of the component. Positive values for patterns, negative ref numbers for hatches.
leftPenWeight	The pen weight of the component's left line.
rightPenWeight	The pen weight of the component's right line.
leftPenStyle	The pen style of the component's left line. Positive values for patterns, negative values for dash styles.
rightPenStyle	The pen style of the component's right line. Positive values for patterns, negative values for dash styles.

See Also:

DeleteComponent  

Declaration:

FUNCTION   ModifySlab

(   slab :HANDLE;     modifier :HANDLE;     isClipObject :BOOLEAN;     componentFlags :LONGINT ) :BOOLEAN ;

Description:

Adds to or clips from a slab.

Parameters:

slab	The slab.
modifier	The adding or clipping object.
isClipObject	Whether the modifier is an add object or a clip object.
componentFlags	Bit flags that indicate which components will be affected by the modification.

Result:

Whether or not the modification succeeds.

See Also:

CreateSlab  

Declaration:

FUNCTION   SetComponentAutoBoundEdgeOffset

(   object :HANDLE;     componentIndex :INTEGER;     autoBoundEdgeOffset :INTEGER ) :BOOLEAN ;

Description:

Sets the auto-bound edge offset of a component in an object.

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.
componentIndex	The index of the component.
autoBoundEdgeOffset	The auto-bound edge offset. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component 6 - Outer face

See Also:

GetComponentAutoBoundEdgeOffset  

Declaration:

FUNCTION   SetComponentClass

(   object :HANDLE;     componentIndex :INTEGER;     componentClass :LONGINT ) :BOOLEAN ;

Description:

Sets the class of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
componentClass	The class of the component.

See Also:

GetComponentClass  

Declaration:

FUNCTION   SetComponentFill

(   object :HANDLE;     componentIndex :INTEGER;     fill :LONGINT ) :BOOLEAN ;

Description:

Sets the fill of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
fill	The fill of the component. Positive values for patterns, negative object indexes for hatches.

See Also:

GetComponentFill  

Declaration:

FUNCTION   SetComponentFillColors

(   object :HANDLE;     componentIndex :INTEGER;     fillForeColor :INTEGER;     fillBackColor :INTEGER ) :BOOLEAN ;

Description:

Sets the fore and back fill colors of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
fillForeColor	The fore color of the fill.
fillBackColor	The back color of the fill.

See Also:

GetComponentFillColors  

Declaration:

FUNCTION   SetComponentFollowBottomWallPeaks

(   object :HANDLE;     componentIndex :INTEGER;     followBottomWallPeaks :BOOLEAN ) :BOOLEAN ;

Description:

Sets the follow bottom wall peaks flag of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
followBottomWallPeaks	Whether or not the component will follow bottom wall peaks.

See Also:

GetComponentFollowBottomWallPeaks  

Declaration:

FUNCTION   SetComponentFollowTopWallPeaks

(   object :HANDLE;     componentIndex :INTEGER;     followTopWallPeaks :BOOLEAN ) :BOOLEAN ;

Description:

Sets the follow top wall peaks flag of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
followTopWallPeaks	Whether or not the component will follow top wall peaks.

See Also:

GetComponentFollowTopWallPeaks  

Declaration:

FUNCTION   SetComponentManualEdgeOffset

(   object :HANDLE;     componentIndex :INTEGER;     manualEdgeOffset :REAL ) :BOOLEAN ;

Description:

Sets the manual edge offset of a component in an object.

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.
componentIndex	The index of the component.
manualEdgeOffset	The manual edge offset.

See Also:

GetComponentManualEdgeOffset  

Declaration:

FUNCTION   SetComponentName

(   object :HANDLE;     componentIndex :INTEGER;     componentName :STRING ) :BOOLEAN ;

Description:

Sets the name of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
componentName	The name of the component.

See Also:

GetComponentName  

Declaration:

FUNCTION   SetComponentPenColors

(   object :HANDLE;     componentIndex :INTEGER;     leftPenForeColor :INTEGER;     leftPenBackColor :INTEGER;     rightPenForeColor :INTEGER;     rightPenBackColor :INTEGER ) :BOOLEAN ;

Description:

Sets the colors of the pens of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
leftPenForeColor	The fore color of the left pen.
leftPenBackColor	The back color of the left pen.
rightPenForeColor	The fore color of the right pen.
rightPenBackColor	The back color of the right pen.

See Also:

GetComponentPenColors  

Declaration:

FUNCTION   SetComponentPenStyles

(   object :HANDLE;     componentIndex :INTEGER;     leftPenStyle :INTEGER;     rightPenStyle :INTEGER ) :BOOLEAN ;

Description:

Sets the left and right pen styles for a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
leftPenStyle	The pen style of the component's left line. Positive values for patterns, negative values for dash styles.
rightPenStyle	The pen style of the component's right line. Positive values for patterns, negative values for dash styles.

See Also:

GetComponentPenStyles  

Declaration:

FUNCTION   SetComponentPenWeights

(   object :HANDLE;     componentIndex :INTEGER;     leftPenWeight :INTEGER;     rightPenWeight :INTEGER ) :BOOLEAN ;

Description:

Sets the left and right pen weights for a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
leftPenWeight	The pen weight of the component's left line.
rightPenWeight	The pen weight of the component's right line.

See Also:

GetComponentPenWeights  

Declaration:

FUNCTION   SetComponentTexture

(   object :HANDLE;     componentIndex :INTEGER;     texture :LONGINT ) :BOOLEAN ;

Description:

Sets the texture of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
texture	The ref number of the texture. 0 for no texture. -1 for class texture.

See Also:

GetComponentTexture  

Declaration:

FUNCTION   SetComponentUseFillClassAttr

(   object :HANDLE;     componentIndex :INTEGER;     useFillClassAttributes :BOOLEAN ) :BOOLEAN ;

Description:

Sets the use fill class attributes flag of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
useFillClassAttributes	Whether or not the component will use class attributes for its fill.

See Also:

GetComponentUseFillClassAttr  

Declaration:

FUNCTION   SetComponentUsePenClassAttr

(   object :HANDLE;     componentIndex :INTEGER;     useLeftPenClassAttributes :BOOLEAN;     useRightPenClassAttributes :BOOLEAN ) :BOOLEAN ;

Description:

Sets the use class attributes flags of the pens of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
useLeftPenClassAttributes	Whether or not the component will use class attributes for its left pen.
useRightPenClassAttributes	Whether or not the component will use class attributes for its right pen.

See Also:

GetComponentUsePenClassAttr  

Declaration:

FUNCTION   SetComponentWallBottomOffset

(   object :HANDLE;     componentIndex :INTEGER;     offsetFromWallBottom :REAL ) :BOOLEAN ;

Description:

Sets the offset from wall bottom of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
offsetFromWallBottom	The offset from wall bottom of the component.

See Also:

GetComponentWallBottomOffset  

Declaration:

FUNCTION   SetComponentWallTopOffset

(   object :HANDLE;     componentIndex :INTEGER;     offsetFromWallTop :REAL ) :BOOLEAN ;

Description:

Sets the offset from wall top of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex	The index of the component.
offsetFromWallTop	The offset from wall top of the component.

See Also:

GetComponentWallTopOffset  

Declaration:

FUNCTION   SetComponentWidth

(   object :HANDLE;     componentIndex :INTEGER;     width :REAL ) :BOOLEAN ;

Description:

Sets the width of a component in an object.

Parameters:

object	The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.
componentIndex	The index of the component.
width	The width of the component.

See Also:

GetComponentWidth  

Declaration:

PROCEDURE   SetCoreWallComponent

(   object :HANDLE;     coreWallComponent :INTEGER ) ;

Description:

Sets the core wall component of an object.

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
coreWallComponent	The index of the core wall component. 0 will cause there to be no core wall component.

See Also:

GetCoreWallComponent  

Declaration:

PROCEDURE   SetDatumSlabComponent

(   object :HANDLE;     datumSlabComponent :INTEGER ) ;

Description:

Sets the datum slab component of an object.

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.
datumSlabComponent	The index of the datum slab component.

See Also:

GetDatumSlabComponent  

Declaration:

PROCEDURE   SetObjectStoryBound

(   object :HANDLE;     boundID :INTEGER;     boundType :INTEGER;     boundStory :INTEGER;     layerLevelType :STRING;     offset :REAL ) ;

Description:

Set the data of the specified story bound of this object.

Parameters:

object	The object.
boundID	The identifier of the story bound.
boundType	Bounding type: 0 - LayerZ; 1 - DefaultWallHeight; 2 - Story
boundStory	The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below.
layerLevelType	The layer type which defines this bound
offset	The offset distance from the specified bound story

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

Declaration:

PROCEDURE   SetSlabHeight

(   slab :HANDLE;     height :REAL ) ;

Description:

Sets the height of a slab.

Parameters:

slab	The slab.
height	The height of the slab.

See Also:

GetSlabHeight  

Declaration:

PROCEDURE   SetSlabPreferencesStyle

( slabStyle:LONGINT ) ;

Description:

Sets the Slab Style of the Slab Preferences.

Parameters:

slabStyle

The ref number of the Slab Style to apply to the Slab Preferences. 0 for unstyled.

See Also:

GetSlabPreferencesStyle  

Declaration:

PROCEDURE   SetSlabStyle

(   slab :HANDLE;     slabStyle :LONGINT ) ;

Description:

Sets the Slab Style of a slab.

Parameters:

slab	The slab.
slabStyle	The ref number of the Slab Style to apply to the slab. 0 for unstyled.

See Also:

GetSlabStyle  

Declaration:

PROCEDURE   SlabFromPoly

( poly:HANDLE ) ;

Description:

Creates a slab object from the referenced polyline. The current settings for the slab object are used to create the new slab.

Parameters:

poly	The polyline that the slab will be created from.

Declaration:

PROCEDURE   SyncMatrixToBound

(   object :HANDLE;     BoundID :INTEGER ) ;

Description:

Synchronize the object's matrix with the specified story bound.

Parameters:

object	The object handle.
BoundID	The identifier of the story bound.